home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / il / ilCallbackList.z / ilCallbackList
Encoding:
Text File  |  2002-10-03  |  5.0 KB  |  133 lines
  1.  
  2.  
  3.  
  4. iiiillllCCCCaaaallllllllbbbbaaaacccckkkkLLLLiiiisssstttt((((3333))))  IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll  iiiillllCCCCaaaallllllllbbbbaaaacccckkkkLLLLiiiisssstttt((((3333))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      iiiillllCCCCaaaallllllllbbbbaaaacccckkkkLLLLiiiisssstttt - a list of callbacks
  10.  
  11. IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
  12.      This is a base class with no inheritance.
  13.  
  14.  
  15. HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
  16.      #include <il/ilCallbackList.h>
  17.  
  18.  
  19. CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  20.      ilCallbackList is a simple class that can be used to maintain a list of
  21.      callbacks.
  22.  
  23. CCCCLLLLAAAASSSSSSSS MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN SSSSUUUUMMMMMMMMAAAARRRRYYYY
  24.      CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr
  25.  
  26.           ilCallbackList()
  27.           ilCallbackList(ilCallbackList* other)
  28.  
  29.      LLLLiiiisssstttt mmmmaaaannnniiiippppuuuullllaaaattttiiiioooonnnn mmmmeeeetttthhhhooooddddssss
  30.  
  31.           void append(ilCallback* cb, int autoDelete=FALSE)
  32.           void insert(ilCallback* cb, int autoDelete=FALSE)
  33.           ilStatus remove(ilCallback* cb)
  34.           int isEmpty()
  35.  
  36.      CCCCaaaallllllllbbbbaaaacccckkkk aaaaccccttttiiiioooonnnn
  37.  
  38.           ilStatus doit(void* callerArg)
  39.  
  40.  
  41.  
  42. FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
  43.      iiiillllCCCCaaaallllllllbbbbaaaacccckkkkLLLLiiiisssstttt(((())))
  44.  
  45.           ilCallbackList()
  46.           ilCallbackList(ilCallbackList* other)
  47.  
  48.  
  49.           The first form of the constructor simply makes an empty callback
  50.           list.  The second form pulls the callbacks off of _o_t_h_e_r and puts
  51.           them on the newly constructed list.
  52.  
  53.      aaaappppppppeeeennnndddd(((())))
  54.  
  55.           void append(ilCallback* cb, int autoDelete=FALSE)
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. iiiillllCCCCaaaallllllllbbbbaaaacccckkkkLLLLiiiisssstttt((((3333))))  IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll  iiiillllCCCCaaaallllllllbbbbaaaacccckkkkLLLLiiiisssstttt((((3333))))
  71.  
  72.  
  73.  
  74.           The method places the callback, _c_b, on the end of the callback list.
  75.           If _a_u_t_o_D_e_l_e_t_e is true, the callback will be automatically deleted
  76.           when the callback list is destroyed.
  77.  
  78.      ddddooooiiiitttt(((())))
  79.  
  80.           ilStatus doit(void* callerArg)
  81.  
  82.  
  83.           This method invokes the ddddooooiiiitttt() method on all callbacks in this list
  84.           with caller arguement, _c_a_l_l_e_r_A_r_g.  The return value is ilOKAY if
  85.           call of the callbacks return ilOKAY, otherwise it will be the return
  86.           status of the first callback that returned bad status.
  87.  
  88.      iiiinnnnsssseeeerrrrtttt(((())))
  89.  
  90.           void insert(ilCallback* cb, int autoDelete=FALSE)
  91.  
  92.  
  93.           The method places the callback, _c_b, on the head of the callback
  94.           list.  If _a_u_t_o_D_e_l_e_t_e is true, the callback will be automatically
  95.           deleted when the callback list is destroyed.
  96.  
  97.      iiiissssEEEEmmmmppppttttyyyy(((())))
  98.  
  99.           int isEmpty()
  100.  
  101.  
  102.           This method returns true if the callback list is empty.
  103.  
  104.      rrrreeeemmmmoooovvvveeee(((())))
  105.  
  106.           ilStatus remove(ilCallback* cb)
  107.  
  108.  
  109.           This method finds the callback, _c_b, on this list and removes it.
  110.           The callback will be deleted if _a_u_t_o_D_e_l_e_t_e was true when the
  111.           callback was appended or inserted on the list.
  112.  
  113.           The returned value is ilOKAY if the callback is found, or
  114.           ilStatusEncode(ilBADOP) if it's not found.
  115.  
  116. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  117.      ilCallback(3)
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.